LotusScript Doc

Class: LSAEMailAddresseS

Maintaines a list of LSAEMailItemS

Version:
1.2.4, 23.NOV.2000 <BR>
History:
23.NOV.2000RGRbug in Get EMailDefaultS
27.JUL.2000RGRproperty DefaultEmail changed
08.JUN.2000RGRdelete method changed



Property Summary
Public Property Get Count As Integer
Public Property Get DefaultEMail As String
Public Property Get EMailAddresseS As Variant
Public Property Get EMailDefaultS As Variant
Public Property Get EMailKeyS As Variant
Public Property Get EMailList As Variant
Public Property Set ItemDelimiter As String
Public Property Get ItemDelimiter As String
Public Property Set ListDelimiter As String
Public Property Get ListDelimiter As String
Public Property Set NotAllowedChars As Variant
Public Property Get NotAllowedChars As Variant

Method Summary
Sub AddItem (NewItem As LSAEMailItem)
Sub ClearAllItems ()
Sub ClearCurrentItem ()
Sub Delete ()
Sub Explode (SerialDataArr As Variant)
Function GetCurrentItem () As LSAEMailItem
Function GetDefaultItem () As LSAEMailItem
Function getEMailData () As String
Function GetFirstItem () As LSAEMailItem
Function GetItemByKey (ItemKey As String, MoveCurrentItem As Integer) As LSAEMailItem
Function GetNextItem () As LSAEMailItem
Function GetPreviousItem () As LSAEMailItem
Function hasChanged () As Integer
Function IsDefault (CompareItem As LSAEMailItem) As Integer
Sub New ()
Function saveToPredefinedFields (doc As NotesDocument) As Integer
Sub SetCurrentItem (NewCurrentItem As LSAEMailItem)
Sub SetDefaultItem (NewDefaultItem As LSAEMailItem)
Sub UpdateCurrentItem (UpdateItem As LSAEMailItem)

Property Detail

Public Property Get DefaultEMail AsString

Returns the formatted attribute of the default LSAEMailItem of the named list.

History:
27.JUL.2000RGRif list is empty an empty string is returned
Summmary Top

Public Property Get EMailList AsVariant

Returns an array of serial data strings. Each entry corresponds to a email address in the NamedList and can be used to explode the list.

Summmary Top

Public Property Get EMailKeyS AsVariant

Returns an array of string with the keys of the email addresses maintained in the list

Summmary Top

Public Property Get EMailAddresseS AsVariant

Returns an array of string filled with the the formatted attribute of the LSAEMailtems maintained by the list

Summmary Top

Public Property Get EMailDefaultS AsVariant

Returns an array of strings. On the position of the DefaultItem of the list the value is "x"

History:
23.NOV.2000RGRCurrentItemKey Point not moved correctly
Summmary Top

Public Property Get Count AsInteger

Returns the number of elements in the email list

Summmary Top

Public Property Set ListDelimiter AsString

When the object is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ListDelimiter AsString

Summmary Top

Public Property Set ItemDelimiter AsString

When the an item is imploded to a serial data string this character will be used as seperator. If the programmer doesn't set a delimiter a default value will be delivered by the class.

Summmary Top

Public Property Get ItemDelimiter AsString

Summmary Top

Public Property Set NotAllowedChars AsVariant

These characters are not allowed to be use in the items

Summmary Top

Public Property Get NotAllowedChars AsVariant

Summmary Top
Method Detail

New

Public Sub New
Initialzes the internal NamedLists.

Summmary Top

Delete

Public Sub Delete
Default destructor of the class. Deletes all child objects

History:
08.JUN.2000RGRDelete the children
Summmary Top

AddItem

Public Sub AddItem(NewItem As LSAEMailItem)
Adds a new LSAEMailItem to the list

Parameters:
newItemLSAEMailItemthe item which is inserted in the list
Summmary Top

ClearCurrentItem

Public Sub ClearCurrentItem
Deletes the current item from the list

Summmary Top

ClearAllItems

Public Sub ClearAllItems
Reinitializes the email list

Summmary Top

UpdateCurrentItem

Public Sub UpdateCurrentItem(UpdateItem As LSAEMailItem)
Updates the current item with the data from the UpdateItem

Parameters:
updateItemLSAEMailItemitem storing the update information
Summmary Top

IsDefault

Public Function IsDefault(CompareItem As LSAEMailItem) As Integer
Checks if the parameter item is the default item of the list.

Returns:
Booleantrue, if the item is the default item
Summmary Top

SetCurrentItem

Public Sub SetCurrentItem(NewCurrentItem As LSAEMailItem)
Set the current item to the parameter item

Summmary Top

SetDefaultItem

Public Sub SetDefaultItem(NewDefaultItem As LSAEMailItem)
Set the default item to the parameter item

Summmary Top

GetItemByKey

Public Function GetItemByKey(ItemKey As String,MoveCurrentItem As Integer) As LSAEMailItem
Summmary Top

GetDefaultItem

Public Function GetDefaultItem As LSAEMailItem
Returns the default item of the list or nothing.

Returns:
LSAEMailItemthe default item
Summmary Top

GetCurrentItem

Public Function GetCurrentItem As LSAEMailItem
Returns the current item of the list

Returns:
LSAEMailItemitem which the current pointer is pointing at
Summmary Top

GetFirstItem

Public Function GetFirstItem As LSAEMailItem
Returns the first item of the list

Returns:
LSAEMailItemthe first item in the list
Summmary Top

GetNextItem

Public Function GetNextItem As LSAEMailItem
Returns the item next to the current item of the list.

Returns:
LSAEMailItemnext item to the current item
Summmary Top

GetPreviousItem

Public Function GetPreviousItem As LSAEMailItem
Summmary Top

saveToPredefinedFields

Public Function saveToPredefinedFields(doc As NotesDocument) As Integer
Stores attribute values for the convinience of the programmer. The fields of documents relate to the subform LSASubEMail from LSL-Address The attribute are only stored if they differ from the values on disk.

Parameters:
docNotesDocumentthe document in which the attributes are stored
Returns:
Booleantrue, if one item of the document has been changed
Summmary Top

Explode

Public Sub Explode(SerialDataArr As Variant)
Fills the list with the serialized object provided by the parameter array The array should be of th form [~x~~Notes~John Doe/ACME~John Doe/ACME, ' ~~~Internet~John Doe@Acme.com~John Doe@ACME.COM] The list also reinitialized this means hasChanged delivers false.

Parameters:
SerialdataArrVariantarray of serial data strings each entry representing an item
Summmary Top

hasChanged

Public Function hasChanged As Integer
Checks if the list has been modified since creation or the last call of the explode method.

Summmary Top

getEMailData

Public Function getEMailData As String
Interface for the class LSAAddressData. Calculates a string of the type ##LotusE# as used in the default data string of an unit

Summmary Top

TopLotusScript Doc
© Lotus Professional Services
generated on : 05-Apr-01 8:40:00 AM